Code Behind is a workflow where you associate code with an instance of a node instead of a type. More...

Inheritance diagram for CodeBehind:

Classes
interface	CommandHandler
	CommandHandler implements a handler for a command. More...

interface	DirectorInterface

Public Member Functions
void	close ()
	Close the object, and release native resources.

Iterable< String >	iterateCommands ()
	Gets an Iterable used to iterate commands handled by this code behind object.

Public Member Functions inherited from NodeComponent
String	getName ()
	Gets the value of #NameProperty.

Node	getNode ()
	Returns the node the node component is attached to or null if node component is not attached to a node.

NodeComponentState	getState ()
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.

boolean	isAttached ()
	Indicates whether node component is attached to a node.

boolean	isAttaching ()
	Indicates whether node component is in the process of attaching to a node.

boolean	isAttachingOrAttached ()
	Indicates whether node component is in the process of attaching to a node or already attached.

boolean	isDetached ()
	Indicates whether node component is detached from any node.

boolean	isDetaching ()
	Indicates whether node component currently detaching from the node.

boolean	isDetachingOrDetached ()
	Indicates whether node component is in the process of detaching from the node or already detached.

void	setName (String value)
	Sets the value of #NameProperty.

Public Member Functions inherited from KanziObject
boolean	equals (Object object)

Domain	getDomain ()
	Returns the domain the object belongs to.

Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object.

long	getNative ()
	Gets a pointer to the backing C++ instance.

TDataType	getOptionalProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.

TDataType	getProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type.

int	hashCode ()

boolean	hasValue (PropertyType< TDataType > propertyType)
	Evaluates whether there are any inputs into the property value.

boolean	isStale ()
	Test if the object is stale i.e.

void	removeLocalValue (PropertyType< TDataType > propertyType)
	Removes the local value associated with the property.

void	setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
	Sets the flag to indicate that the property was loaded from KZB.

void	setProperty (PropertyType< TDataType > propertyType, TDataType value)
	Sets the local value of a property type.

ObjectRef< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject.

Static Public Attributes
static final Metaclass	metaclass = CodeBehindMetadata.metaclass
	The Metaclass for the class.

Static Public Attributes inherited from NodeComponent
static final Metaclass	metaclass
	The Metaclass for the class.

Static Public Attributes inherited from KanziObject
static final Metaclass	metaclass = new AbstractMetaclass("Kanzi.Object")
	The Metaclass for the class.

Protected Member Functions
	CodeBehind (Domain domain, long handle, Metaclass metaclass)
	Wraps a given native CodeBehind.

void	initialize ()
	Initializes the CodeBehind.

void	registerCommand (String commandName, CodeBehind.CommandHandler handler)
	Registers a new command handler.

abstract void	registerCommandsOverride ()
	Override this method to register commands.

void	unregisterCommand (String commandName)
	Unregisters a command handler.

abstract void	unregisterCommandsOverride ()
	Override this method to unregister the registered commands.

Protected Member Functions inherited from NodeComponent
	NodeComponent (Domain domain, long handle, Metaclass metaclass)
	Wraps a given native Node Component.

void	attachOverride ()
	Called when the Trigger is attached to a node.

void	detachOverride ()
	Called when a Trigger is detached from a Node.

void	removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
	Removes message handler added via `com.rightware.kanzi.NodeComponent#addNodeComponentMessageHandler` function.

Static Protected Member Functions
static< Derived extends NodeComponent > ObjectRef< Derived >	createDerived (Domain domain, String name, Metaclass metaclass)
	Creates a derived class instance.

Additional Inherited Members
Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
	Metaclass for NodeComponent.

DynamicPropertyType< String >	NameProperty
	Name.

Public Attributes inherited from CodeBehindMetadata
DynamicPropertyType< String >	CodeBehindSourceProperty
	Sets the metaclass name of the code behind class for this node.

AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.CodeBehind")
	Metaclass for CodeBehind.

Detailed Description

Code Behind is a workflow where you associate code with an instance of a node instead of a type.

In Code Behind you write code that you want to associate with the view or controller parts of the model-view-controller pattern.

All Activity Host code behind classes inherit from this class.

See also: ActivityCodeBehind, ExclusiveActivityHost2D, ExclusiveActivityHost3D, ParallelActivityHost2D, ParallelActivityHost3D.

Constructor & Destructor Documentation

◆ CodeBehind()

CodeBehind	(	Domain	domain,
		long	handle,
		Metaclass	metaclass )

protected

Wraps a given native CodeBehind.

Called by com.rightware.kanzi.KanziObject#connectObject(long) when connecting to a native CodeBehind.

Parameters

domain	UI Domain where the object belongs.
handle	Native object that is backing the object.
metaclass	Metaclass data for the object.

Member Function Documentation

◆ close()

void close ( )

Close the object, and release native resources.

Reimplemented from NodeComponent.

Reimplemented in ActivityCodeBehind.

◆ createDerived()

static< Derived extends NodeComponent > ObjectRef< Derived > createDerived	(	Domain	domain,
		String	name,
		Metaclass	metaclass )

staticprotected

Creates a derived class instance.

Call this method as part of the create method for a derived class.

Parameters

domain	UI Domain where this object belongs.
name	Name of the object
metaclass	Metaclass data of the object.

Returns: An ObjectRef that holds the created instance.

Reimplemented from NodeComponent.

Reimplemented in ActivityCodeBehind.

◆ initialize()

void initialize ( )

protected

Initializes the CodeBehind.

Reimplemented from NodeComponent.

Reimplemented in ActivityCodeBehind.

◆ iterateCommands()

Iterable< String > iterateCommands ( )

Gets an Iterable used to iterate commands handled by this code behind object.

Returns: An Iterable of commands handled by this code behind object.

◆ registerCommand()

void registerCommand	(	String	commandName,
		CodeBehind.CommandHandler	handler )

protected

Registers a new command handler.

A command is a form of user input. The code behind class of a node can register a handler for a command and perform an operation in the handler. You must call this method in com.rightware.kanzi.CodeBehind#registerCommandsOverride.

Parameters

commandName	The name of the command that you want to handle.
handler	The handler functor for the command.

See also: Command, com.rightware.kanzi.CodeBehind#unregisterCommandsOverride

◆ registerCommandsOverride()

abstract void registerCommandsOverride ( )

abstractprotected

Override this method to register commands.

You must register every command using com.rightware.kanzi.CodeBehind#registerCommand. Kanzi registers commands when it attaches the node that uses this code behind.

◆ unregisterCommand()

void unregisterCommand ( String commandName )

protected

Unregisters a command handler.

You must call this method in com.rightware.kanzi.CodeBehind#unregisterCommandsOverride.

Parameters

commandName The name of the command for which you previously registered a handler.

See also: Command, com.rightware.kanzi.CodeBehind#registerCommand

◆ unregisterCommandsOverride()

abstract void unregisterCommandsOverride ( )

abstractprotected

Override this method to unregister the registered commands.

You must unregister every registered command using com.rightware.kanzi.CodeBehind#unregisterCommand. Kanzi changes the status of a command to unregistered when it detaches the node that uses this code behind.

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CodeBehind()

Member Function Documentation

◆ close()

◆ createDerived()

◆ initialize()

◆ iterateCommands()

◆ registerCommand()

◆ registerCommandsOverride()

◆ unregisterCommand()

◆ unregisterCommandsOverride()